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