<?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="atomsRepositoryList">
    <refnamediv>
        <refname>atomsRepositoryList</refname>
        <refpurpose>Get the list of managed repositories</refpurpose>
    </refnamediv>
    <!-- ===================================================================== -->
    <!-- Syntax -->
    <!-- ===================================================================== -->
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            repositories = atomsRepositoryList()
            repositories = atomsRepositoryList(section)
        </synopsis>
    </refsynopsisdiv>
    <!-- ===================================================================== -->
    <!-- Parameters -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>section</term>
                <listitem>
                    <para>
                        This argument controls the list of section where search URL(s).
                    </para>
                    <para>
                        <literal>section</literal> is a single-string and its value should be :
                    </para>
                    <itemizedlist>
                        <listitem>
                            <para>
                                <literal>"all"</literal>: URL(s) present in the "user", "allusers"
                                and "official" section are listed.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>"allusers"</literal>: only URL(s) present in the "allusers"
                                section are listed.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>"user"</literal>: only URL(s) present in the "user"
                                section are listed.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>"official"</literal>: only URL(s) present in the "official"
                                section are listed.
                            </para>
                        </listitem>
                    </itemizedlist>
                    <para>
                        The default value is "all".
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>repositories</term>
                <listitem>
                    <para>
                        Matrix of strings : the first column give the list of repositories
                        managed by ATOMS and the second column indicate if the repository is
                        an official repository, if the repository has been added for all users
                        or only for the current user.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Description -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Description</title>
        <para>
            <literal>atomsRepositoryList</literal> return a matrix that give the list of
            available repositories.
        </para>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Examples -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
atomsRepositoryAdd('https://scene1.test.atoms.scilab.org');
atomsRepositoryList()
atomsRepositoryList('all')
atomsRepositoryList('official')
atomsRepositoryList('allusers')
atomsRepositoryList('user')
atomsRepositoryDel('https://scene1.test.atoms.scilab.org');
 ]]></programlisting>
    </refsection>
    <!-- ===================================================================== -->
    <!-- See also -->
    <!-- ===================================================================== -->
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="atomsRepositoryAdd">atomsRepositoryAdd</link>
            </member>
            <member>
                <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
            </member>
        </simplelist>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Authors -->
    <!-- ===================================================================== -->
</refentry>
