blob: d64cec5d227754446c1448bb5f887cf44e3f746c (
plain)
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
191
192
193
194
195
196
|
<?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:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="atomsGetConfig" xml:lang="en">
<refnamediv>
<refname>atomsGetConfig</refname>
<refpurpose>Get ATOMS system parameters</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
result = atomsGetConfig(parameter)
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>parameter</term>
<listitem>
<para>single-string matrix</para>
</listitem>
</varlistentry>
<varlistentry>
<term>result</term>
<listitem>
Value of the parameter
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Proxy</title>
<para>
<informaltable border="1">
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Values</th>
</tr>
<tr>
<td>useProxy</td>
<td>Use/Don't use proxies</td>
<td>
<emphasis role="strong">"True"</emphasis>/"False"
</td>
</tr>
<tr>
<td>proxyHost</td>
<td>the hostname (IP or DNS name)</td>
<td/>
</tr>
<tr>
<td>proxyPort</td>
<td>the port</td>
<td/>
</tr>
<tr>
<td>proxyUser</td>
<td>Specify the username for authentication on a proxy server</td>
<td/>
</tr>
<tr>
<td>proxyPassword</td>
<td>Specify the password for authentication on a proxy server</td>
<td/>
</tr>
</informaltable>
</para>
</refsection>
<refsection>
<title>Network</title>
<para>
<informaltable border="1">
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Values</th>
</tr>
<tr>
<td>offline</td>
<td>If set to "True", the system only works with local repositories.
The offline mode permits the user to install modules from a local
repository or a local package (hard disk, USB keys, ...) even if the
network is unreachable. In version prior to 5.4.0, this tag was
called offLine.
</td>
<td>
"True"/<emphasis role="strong">"False"</emphasis>
</td>
</tr>
</informaltable>
</para>
</refsection>
<refsection>
<title>Autoload System</title>
<para>
<informaltable border="1">
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Values</th>
</tr>
<tr>
<td>autoload</td>
<td>Enable/Disable autoload system</td>
<td>
<emphasis role="strong">"True"</emphasis>/"False"
</td>
</tr>
<tr>
<td>autoloadAddAfterInstall</td>
<td>Automatically add a module to the list of module to autoload at
Scilab start
</td>
<td>
<emphasis role="strong">"True"</emphasis>/"False"
</td>
</tr>
</informaltable>
</para>
</refsection>
<refsection>
<title>Miscellaneous</title>
<para>
<informaltable border="1">
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Values</th>
</tr>
<tr>
<td>verbose</td>
<td>Display or not extra-information</td>
<td>
"True"/<emphasis role="strong">"False"</emphasis>
</td>
</tr>
<tr>
<td>downloadTool</td>
<td> Get tool used for download</td>
<td> "curl", "wget" or "httpdownload" (Windows only)</td>
</tr>
<tr>
<td>downloadTimeout</td>
<td> Get timeout used for download (seconds)</td>
<td> "5" is the default value</td>
</tr>
<tr>
<td>updateTime</td>
<td> Get time between updates (days)</td>
<td> one month is the default value</td>
</tr>
</informaltable>
</para>
</refsection>
<refsection>
<title>Description</title>
<para>
<literal>atomsGetConfig</literal> returns the value of the parameter
given
</para>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="atomsSetConfig">atomsSetConfig</link>
</member>
</simplelist>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example">// Get value of verbose parameter
atomsGetConfig("Verbose")
</programlisting>
</refsection>
<refsection>
<title>History</title>
<revhistory>
<revision>
<revnumber>5.4.0</revnumber>
<revdescription>offLine parameter renamed to offline</revdescription>
</revision>
</revhistory>
</refsection>
</refentry>
|
