<?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:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
          xml:lang="en" xml:id="atomsRepositoryAdd">
    <refnamediv>
        <refname>atomsRepositoryAdd</refname>
        <refpurpose>Add one or several URLs to the list of managed repositories</refpurpose>
    </refnamediv>
    <!-- ===================================================================== -->
    <!-- Syntax -->
    <!-- ===================================================================== -->
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            nbAdd = atomsRepositoryAdd(url)
            nbAdd = atomsRepositoryAdd(url, section)
        </synopsis>
    </refsynopsisdiv>
    <!-- ===================================================================== -->
    <!-- Parameters -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>url</term>
                <listitem>
                    <para>
                        Matrix of strings : list of the URLs to add
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>section</term>
                <listitem>
                    <para>
                        This argument controls where the repository is added.
                    </para>
                    <para>
                        <literal>section</literal> is a single-string and its value should be :
                    </para>
                    <itemizedlist>
                        <listitem>
                            <para>
                                <literal>"allusers"</literal>: the repository is added to the
                                "allusers" list and all user of scilab are affected.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>"user"</literal>: the repository is added to the
                                "user" list and only the current user is affected.
                            </para>
                        </listitem>
                    </itemizedlist>
                    <para>
                        If SCI/contrib is write accessible, "allusers" is the default value.
                        Otherwise, the default value is "user".
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>nbAdd</term>
                <listitem>
                    <para>
                        An integer : the number of repositories successfully added.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Description -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Description</title>
        <para>

        </para>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Examples -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
atomsRepositoryList()
atomsRepositoryAdd(["https://scene1.test.atoms.scilab.org"])
atomsRepositoryList()
 ]]></programlisting>
    </refsection>
    <!-- ===================================================================== -->
    <!-- See also -->
    <!-- ===================================================================== -->
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
            </member>
            <member>
                <link linkend="atomsRepositoryList">atomsRepositoryList</link>
            </member>
        </simplelist>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Authors -->
    <!-- ===================================================================== -->
</refentry>
