26447fe114fd30bca130acc8c3226724ce6e7460
[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  * 
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="atomsSetConfig">
14   <refnamediv>
15     <refname>atomsSetConfig</refname>
16     <refpurpose>Manage ATOMS system parameters</refpurpose>
17   </refnamediv>
18   <!-- ===================================================================== -->
19   <!-- Calling Sequence -->
20   <!-- ===================================================================== -->
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24       result = atomsSetConfig(parameter,value)
25     </synopsis>
26   </refsynopsisdiv>
27   <!-- ===================================================================== -->
28   <!-- Parameters -->
29   <!-- ===================================================================== -->
30   <refsection>
31     <title>Arguments</title>
32     <variablelist>
33       <varlistentry>
34         <term>parameter</term>
35         <listitem>
36           <para>
37             single-string matrix
38           </para>
39         </listitem>
40       </varlistentry>
41       <varlistentry>
42         <term>value</term>
43         <listitem>
44           <para>
45             single-string matrix
46           </para>
47         </listitem>
48       </varlistentry>
49       <varlistentry>
50         <term>result</term>
51         <listitem>
52           Number of changed parameters
53         </listitem>
54       </varlistentry>
55     </variablelist>
56   </refsection>
57   <refsection>
58     <title>Proxy</title>
59     <para>
60       <informaltable border="1">
61         <tr>
62           <th>Parameter</th>
63           <th>Description</th>
64           <th>Values</th>
65         </tr>
66         <tr>
67           <td>useProxy</td>
68           <td>Use/Don't use proxies</td>
69           <td>
70             <emphasis role="strong">True</emphasis>/False
71           </td>
72         </tr>
73         <tr>
74           <td>proxyHost</td>
75           <td>the hostname (IP or DNS name)</td>
76           <td/>
77         </tr>
78         <tr>
79           <td>proxyPort</td>
80           <td>the port</td>
81           <td/>
82         </tr>
83         <tr>
84           <td>proxyUser</td>
85           <td>Specify the username for authentication on a proxy server</td>
86           <td/>
87         </tr>
88         <tr>
89           <td>proxyPassword</td>
90           <td>Specify the password for authentication on a proxy server</td>
91           <td/>
92         </tr>
93       </informaltable>
94     </para>
95   </refsection>
96   <refsection>
97     <title>Network</title>
98     <para>
99       <informaltable border="1">
100         <tr>
101           <th>Parameter</th>
102           <th>Description</th>
103           <th>Values</th>
104         </tr>
105         <tr>
106           <td>offline</td>
107           <td>
108             If set to "True", the system only works with local repositories.
109             The offline mode permits the user to install modules from a local
110             repository or a local package (hard disk, USB keys, ...) even if
111             the network is unreachable.
112             In version prior to 5.4.0, this tag was called offLine.
113           </td>
114           <td>
115             True/<emphasis role="strong">False</emphasis>
116           </td>
117         </tr>
118       </informaltable>
119     </para>
120   </refsection>
121   <refsection>
122     <title>Autoload System</title>
123     <para>
124       <informaltable border="1">
125         <tr>
126           <th>Parameter</th>
127           <th>Description</th>
128           <th>Values</th>
129         </tr>
130         <tr>
131           <td>autoload</td>
132           <td>Enable/Disable autoload system</td>
133           <td>
134             <emphasis role="strong">True</emphasis>/False
135           </td>
136         </tr>
137         <tr>
138           <td>autoloadAddAfterInstall</td>
139           <td>Automatically add a module to the list of module to autoload at Scilab start</td>
140           <td>
141             <emphasis role="strong">True</emphasis>/False
142           </td>
143         </tr>
144       </informaltable>
145     </para>
146   </refsection>
147   <refsection>
148     <title>Miscellenous</title>
149     <para>
150       <informaltable border="1">
151         <tr>
152           <th>Parameter</th>
153           <th>Description</th>
154           <th>Values</th>
155         </tr>
156         <tr>
157           <td>Verbose</td>
158           <td>Display or not extra-informations</td>
159           <td>
160             True/<emphasis role="strong">False</emphasis>
161           </td>
162         </tr>
163       </informaltable>
164     </para>
165   </refsection>
166   <!-- ===================================================================== -->
167   <!-- Description -->
168   <!-- ===================================================================== -->
169   <refsection>
170     <title>Description</title>
171     <para>
172       <literal>atomsSetConfig</literal> returns the list of modules registered to autoload
173     </para>
174   </refsection>
175   <!-- ===================================================================== -->
176   <!-- Examples -->
177   <!-- ===================================================================== -->
178   <refsection>
179     <title>Examples</title>
180     <programlisting role="example"><![CDATA[
181 // Display extra-informations
182 atomsSetConfig('Verbose','True')
183
184 // Disable autoload system
185 atomsSetConfig('autoload','False')
186 ]]></programlisting>
187   </refsection>
188   <refsection>
189     <title>History</title>
190     <revhistory>
191       <revision>
192         <revnumber>5.4.0</revnumber>
193         <revdescription>offLine parameter renamed to offline</revdescription>
194       </revision>
195     </revhistory>
196   </refsection>
197 </refentry>