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