Bug #10846 fixed - atomsSystemUpdate failed.
[scilab.git] / scilab / modules / atoms / help / en_US / atomsSetConfig.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  * Copyright (C) DIGITEO - 2012 - Allan CORNET
6  *
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14 <refentry version="5.0-subset Scilab" xml:id="atomsSetConfig" xml:lang="en"
15           xmlns="http://docbook.org/ns/docbook"
16           xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg"
18           xmlns:ns4="http://www.w3.org/1999/xhtml"
19           xmlns:mml="http://www.w3.org/1998/Math/MathML"
20           xmlns:db="http://docbook.org/ns/docbook">
21   <refnamediv>
22     <refname>atomsSetConfig</refname>
23
24     <refpurpose>Manage ATOMS system parameters</refpurpose>
25   </refnamediv>
26
27   <refsynopsisdiv>
28     <title>Calling Sequence</title>
29
30     <synopsis>
31       result = atomsSetConfig(parameter, value)
32     </synopsis>
33   </refsynopsisdiv>
34
35   <refsection>
36     <title>Arguments</title>
37
38     <variablelist>
39       <varlistentry>
40         <term>parameter</term>
41
42         <listitem>
43           <para>single-string matrix</para>
44         </listitem>
45       </varlistentry>
46
47       <varlistentry>
48         <term>value</term>
49
50         <listitem>
51           <para>single-string matrix</para>
52         </listitem>
53       </varlistentry>
54
55       <varlistentry>
56         <term>result</term>
57
58         <listitem>
59            Number of changed parameters
60         </listitem>
61       </varlistentry>
62     </variablelist>
63   </refsection>
64
65   <refsection>
66     <title>Proxy</title>
67
68     <para><informaltable border="1">
69         <tr>
70           <th>Parameter</th>
71
72           <th>Description</th>
73
74           <th>Values</th>
75         </tr>
76
77         <tr>
78           <td>useProxy</td>
79
80           <td>Use/Don't use proxies</td>
81
82           <td><emphasis role="strong">True</emphasis>/False</td>
83         </tr>
84
85         <tr>
86           <td>proxyHost</td>
87
88           <td>the hostname (IP or DNS name)</td>
89
90           <td></td>
91         </tr>
92
93         <tr>
94           <td>proxyPort</td>
95
96           <td>the port</td>
97
98           <td></td>
99         </tr>
100
101         <tr>
102           <td>proxyUser</td>
103
104           <td>Specify the username for authentication on a proxy server</td>
105
106           <td></td>
107         </tr>
108
109         <tr>
110           <td>proxyPassword</td>
111
112           <td>Specify the password for authentication on a proxy server</td>
113
114           <td></td>
115         </tr>
116       </informaltable></para>
117   </refsection>
118
119   <refsection>
120     <title>Network</title>
121
122     <para><informaltable border="1">
123         <tr>
124           <th>Parameter</th>
125
126           <th>Description</th>
127
128           <th>Values</th>
129         </tr>
130
131         <tr>
132           <td>offline</td>
133
134           <td>If set to "True", the system only works with local repositories.
135           The offline mode permits the user to install modules from a local
136           repository or a local package (hard disk, USB keys, ...) even if the
137           network is unreachable. In version prior to 5.4.0, this tag was
138           called offLine.</td>
139
140           <td>True/<emphasis role="strong">False</emphasis></td>
141         </tr>
142       </informaltable></para>
143   </refsection>
144
145   <refsection>
146     <title>Autoload System</title>
147
148     <para><informaltable border="1">
149         <tr>
150           <th>Parameter</th>
151
152           <th>Description</th>
153
154           <th>Values</th>
155         </tr>
156
157         <tr>
158           <td>autoload</td>
159
160           <td>Enable/Disable autoload system</td>
161
162           <td><emphasis role="strong">True</emphasis>/False</td>
163         </tr>
164
165         <tr>
166           <td>autoloadAddAfterInstall</td>
167
168           <td>Automatically add a module to the list of module to autoload at
169           Scilab start</td>
170
171           <td><emphasis role="strong">True</emphasis>/False</td>
172         </tr>
173       </informaltable></para>
174   </refsection>
175
176   <refsection>
177     <title>Miscellenous</title>
178
179     <para><informaltable border="1">
180         <tr>
181           <th>Parameter</th>
182
183           <th>Description</th>
184
185           <th>Values</th>
186         </tr>
187
188         <tr>
189           <td>Verbose</td>
190
191           <td>Display or not extra-informations</td>
192
193           <td>True/<emphasis role="strong">False</emphasis></td>
194         </tr>
195
196         <tr>
197           <td>downloadTool</td>
198
199           <td>Set tool used to download</td>
200
201           <td>"curl", "wget" or "httpdownload" (Windows only)</td>
202         </tr>
203
204         <tr>
205           <td>downloadTimeout</td>
206
207           <td>Set timeout for download</td>
208
209           <td>"5" by default</td>
210         </tr>
211       </informaltable></para>
212   </refsection>
213
214   <refsection>
215     <title>Description</title>
216
217     <para><literal>atomsSetConfig</literal> returns the list of modules
218     registered to autoload</para>
219   </refsection>
220
221   <refsection>
222     <title>Examples</title>
223
224     <programlisting role="example">// Display extra-informations
225 atomsSetConfig('Verbose','True')
226
227 // Disable autoload system
228 atomsSetConfig('autoload','False')</programlisting>
229   </refsection>
230
231   <refsection role="see also">
232     <title>See Also</title>
233
234     <simplelist type="inline">
235       <member><link linkend="atomsGetConfig">atomsGetConfig</link></member>
236     </simplelist>
237   </refsection>
238
239   <refsection>
240     <title>History</title>
241
242     <revhistory>
243       <revision>
244         <revnumber>5.4.0</revnumber>
245
246         <revdescription>offLine parameter renamed to offline</revdescription>
247       </revision>
248     </revhistory>
249   </refsection>
250 </refentry>