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