Bug #10846 fixed - atomsSystemUpdate failed.
[scilab.git] / scilab / modules / atoms / help / en_US / atomsGetConfig.xml
index 4e2dfef..7bbb06e 100644 (file)
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<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">
+<refentry version="5.0-subset Scilab" xml:id="atomsGetConfig" xml:lang="en"
+          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">
   <refnamediv>
     <refname>atomsGetConfig</refname>
+    
     <refpurpose>Get ATOMS system parameters</refpurpose>
   </refnamediv>
-  <!-- ===================================================================== -->
-  <!-- Calling Sequence -->
-  <!-- ===================================================================== -->
+  
   <refsynopsisdiv>
     <title>Calling Sequence</title>
+    
     <synopsis>
       result = atomsGetConfig(parameter)
     </synopsis>
   </refsynopsisdiv>
-  <!-- ===================================================================== -->
-  <!-- Parameters -->
-  <!-- ===================================================================== -->
+  
   <refsection>
     <title>Arguments</title>
+    
     <variablelist>
       <varlistentry>
         <term>parameter</term>
+        
         <listitem>
-          <para>
-            single-string matrix
-          </para>
+          <para>single-string matrix</para>
         </listitem>
       </varlistentry>
+      
       <varlistentry>
         <term>result</term>
+        
         <listitem>
           Value of the parameter
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+  
   <refsection>
     <title>Proxy</title>
-    <para>
-      <informaltable border="1">
+    
+    <para><informaltable border="1">
         <tr>
           <th>Parameter</th>
+          
           <th>Description</th>
+          
           <th>Values</th>
         </tr>
+        
         <tr>
           <td>useProxy</td>
+          
           <td>Use/Don't use proxies</td>
+          
           <td>
             <emphasis role="strong">True</emphasis>/False
           </td>
         </tr>
+        
         <tr>
           <td>proxyHost</td>
+          
           <td>the hostname (IP or DNS name)</td>
-          <td/>
+          
+          <td></td>
         </tr>
+        
         <tr>
           <td>proxyPort</td>
+          
           <td>the port</td>
-          <td/>
+          
+          <td></td>
         </tr>
+        
         <tr>
           <td>proxyUser</td>
+          
           <td>Specify the username for authentication on a proxy server</td>
-          <td/>
+          
+          <td></td>
         </tr>
+        
         <tr>
           <td>proxyPassword</td>
+          
           <td>Specify the password for authentication on a proxy server</td>
-          <td/>
+          
+          <td></td>
         </tr>
       </informaltable>
     </para>
   </refsection>
+  
   <refsection>
     <title>Network</title>
-    <para>
-      <informaltable border="1">
+    
+    <para><informaltable border="1">
         <tr>
           <th>Parameter</th>
+          
           <th>Description</th>
+          
           <th>Values</th>
         </tr>
+        
         <tr>
           <td>offline</td>
-          <td>
-            If set to "True", the system only works with local repositories.
+          
+          <td>If set to "True", the system only works with local repositories.
             The offline mode permits the user to install modules from a local
-            repository or a local package (hard disk, USB keys, ...) even if
-            the network is unreachable.
-            In version prior to 5.4.0, this tag was called offLine.
+            repository or a local package (hard disk, USB keys, ...) even if the
+            network is unreachable. In version prior to 5.4.0, this tag was
+            called offLine.
           </td>
+          
           <td>
             True/<emphasis role="strong">False</emphasis>
           </td>
       </informaltable>
     </para>
   </refsection>
+  
   <refsection>
     <title>Autoload System</title>
-    <para>
-      <informaltable border="1">
+    
+    <para><informaltable border="1">
         <tr>
           <th>Parameter</th>
+          
           <th>Description</th>
+          
           <th>Values</th>
         </tr>
+        
         <tr>
           <td>autoload</td>
+          
           <td>Enable/Disable autoload system</td>
+          
           <td>
             <emphasis role="strong">True</emphasis>/False
           </td>
         </tr>
+        
         <tr>
           <td>autoloadAddAfterInstall</td>
-          <td>Automatically add a module to the list of module to autoload at Scilab start</td>
+          
+          <td>Automatically add a module to the list of module to autoload at
+            Scilab start
+          </td>
+          
           <td>
             <emphasis role="strong">True</emphasis>/False
           </td>
       </informaltable>
     </para>
   </refsection>
+  
   <refsection>
     <title>Miscellenous</title>
-    <para>
-      <informaltable border="1">
+    
+    <para><informaltable border="1">
         <tr>
           <th>Parameter</th>
+          
           <th>Description</th>
+          
           <th>Values</th>
         </tr>
+        
         <tr>
           <td>verbose</td>
+          
           <td>Display or not extra-informations</td>
+          
           <td>
             True/<emphasis role="strong">False</emphasis>
           </td>
         </tr>
+        
+        <tr>
+          <td>downloadTool</td>
+          
+          <td> Get tool used for download</td>
+          
+          <td> "curl", "wget" or "httpdownload" (Windows only)</td>
+        </tr>
+        
+        <tr>
+          <td>downloadTimeout</td>
+          
+          <td> Get timeout used for download</td>
+          
+          <td> "5" is the default value</td>
+        </tr>
       </informaltable>
     </para>
   </refsection>
-  <!-- ===================================================================== -->
-  <!-- Description -->
-  <!-- ===================================================================== -->
+  
   <refsection>
     <title>Description</title>
+    
     <para>
-      <literal>atomsGetConfig</literal> returns the value of the parameter given
+      <literal>atomsGetConfig</literal> returns the value of the parameter
+      given
     </para>
   </refsection>
-  <!-- ===================================================================== -->
-  <!-- Examples -->
-  <!-- ===================================================================== -->
+  
+  <refsection role="see also">
+    <title>See Also</title>
+    
+    <simplelist type="inline">
+      <member>
+        <link linkend="atomsSetConfig">atomsSetConfig</link>
+      </member>
+    </simplelist>
+  </refsection>
+  
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
-// Get value of verbose parameter
-atomsGetConfig('Verbose')
-]]></programlisting>
+    
+    <programlisting role="example">// Get value of verbose parameter
+      atomsGetConfig('Verbose')
+    </programlisting>
   </refsection>
+  
   <refsection>
     <title>History</title>
+    
     <revhistory>
       <revision>
         <revnumber>5.4.0</revnumber>
+        
         <revdescription>offLine parameter renamed to offline</revdescription>
       </revision>
     </revhistory>