ATOMS: atomsRepositoryXXX: Better management of "allusers"/"user" sections
[scilab.git] / scilab / modules / atoms / help / en_US / atomsRepositoryList.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="atomsRepositoryList">
14   <refnamediv>
15     <refname>atomsRepositoryList</refname>
16     <refpurpose>Get the list of managed repositories</refpurpose>
17   </refnamediv>
18   <!-- ===================================================================== -->
19   <!-- Calling Sequence -->
20   <!-- ===================================================================== -->
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24                         repositories = atomsRepositoryList([section])
25                 </synopsis>
26   </refsynopsisdiv>
27   <!-- ===================================================================== -->
28   <!-- Parameters -->
29   <!-- ===================================================================== -->
30   <refsection>
31     <title>Parameters</title>
32     <variablelist>
33                         <varlistentry>
34         <term>section</term>
35         <listitem>
36           <para>
37                                                 This argument controls the list of section where search URL(s).
38                                         </para>
39           <para>
40                                                 <literal>section</literal> is a single-string and its value should be :
41                                         </para>
42           <itemizedlist>
43             <listitem>
44               <para>
45                                                                 <literal>"all"</literal>: URL(s) present in the "user", "allusers"
46                                                                 and "official" section are listed.
47                                                         </para>
48             </listitem>
49             <listitem>
50               <para>
51                                                                 <literal>"allusers"</literal>: only URL(s) present in the "allusers"
52                                                                 section are listed.
53                                                         </para>
54             </listitem>
55             <listitem>
56               <para>
57                                                                 <literal>"user"</literal>: only URL(s) present in the "user"
58                                                                 section are listed.
59                                                         </para>
60             </listitem>
61             <listitem>
62               <para>
63                                                                 <literal>"official"</literal>: only URL(s) present in the "official"
64                                                                 section are listed.
65                                                         </para>
66             </listitem>
67           </itemizedlist>
68                                         <para>
69                                                 The default value is "all".
70                                         </para>
71         </listitem>
72                         </varlistentry>
73       <varlistentry>
74         <term>repositories</term>
75         <listitem>
76           <para>
77                                                 Matrix of strings : the first column give the list of repositories
78                                                 managed by ATOMS and the second column indicate if the repository is
79                                                 a official repository, if the repository has been added for all users
80                                                 or only for the current user.
81                                         </para>
82         </listitem>
83       </varlistentry>
84     </variablelist>
85   </refsection>
86   <!-- ===================================================================== -->
87   <!-- Description -->
88   <!-- ===================================================================== -->
89   <refsection>
90     <title>Description</title>
91     <para><literal>atomsRepositoryList</literal> return a matrix that give the list of
92     available repositories.
93         </para>
94   </refsection>
95   <!-- ===================================================================== -->
96   <!-- Examples -->
97   <!-- ===================================================================== -->
98   <refsection>
99     <title>Examples</title>
100     <programlisting role="example"><![CDATA[
101 atomsRepositoryAdd('http://scene1.atoms.scilab.org');
102 atomsRepositoryList()
103 atomsRepositoryList('all')
104 atomsRepositoryList('official')
105 atomsRepositoryList('allusers')
106 atomsRepositoryList('user')
107 atomsRepositoryDel('http://scene1.atoms.scilab.org');
108  ]]></programlisting>
109   </refsection>
110   <!-- ===================================================================== -->
111   <!-- See also -->
112   <!-- ===================================================================== -->
113   <refsection>
114     <title>See Also</title>
115     <simplelist type="inline">
116       <member>
117         <link linkend="atomsRepositoryAdd">atomsRepositoryAdd</link>
118       </member>
119       <member>
120         <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
121       </member>
122     </simplelist>
123   </refsection>
124   <!-- ===================================================================== -->
125   <!-- Authors -->
126   <!-- ===================================================================== -->
127   <refsection>
128     <title>Authors</title>
129     <simplelist type="vert">
130       <member>Pierre MARECHAL - DIGITEO</member>
131     </simplelist>
132   </refsection>
133 </refentry>