<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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">
    <refnamediv>
        <refname>atomsGetConfig</refname>
        <refpurpose>Get ATOMS system parameters</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            result = atomsGetConfig(parameter)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>parameter</term>
                <listitem>
                    <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">
                <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/>
                </tr>
                <tr>
                    <td>proxyPort</td>
                    <td>the port</td>
                    <td/>
                </tr>
                <tr>
                    <td>proxyUser</td>
                    <td>Specify the username for authentication on a proxy server</td>
                    <td/>
                </tr>
                <tr>
                    <td>proxyPassword</td>
                    <td>Specify the password for authentication on a proxy server</td>
                    <td/>
                </tr>
            </informaltable>
        </para>
    </refsection>
    <refsection>
        <title>Network</title>
        <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.
                        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.
                    </td>
                    <td>
                        "True"/<emphasis role="strong">"False"</emphasis>
                    </td>
                </tr>
            </informaltable>
        </para>
    </refsection>
    <refsection>
        <title>Autoload System</title>
        <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>
                        <emphasis role="strong">"True"</emphasis>/"False"
                    </td>
                </tr>
            </informaltable>
        </para>
    </refsection>
    <refsection>
        <title>Miscellaneous</title>
        <para>
            <informaltable border="1">
                <tr>
                    <th>Parameter</th>
                    <th>Description</th>
                    <th>Values</th>
                </tr>
                <tr>
                    <td>verbose</td>
                    <td>Display or not extra-information</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 (seconds)</td>
                    <td> "5" is the default value</td>
                </tr>
                <tr>
                    <td>updateTime</td>
                    <td> Get time between updates (days)</td>
                    <td> one month is the default value</td>
                </tr>
            </informaltable>
        </para>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>atomsGetConfig</literal> returns the value of the parameter
            given
        </para>
    </refsection>
    <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">// 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>
    </refsection>
</refentry>
