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