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