d624feb67cf3b8a6b7007ff26dafca70ab6b62fe
[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()
25                         repositories = atomsRepositoryList(level)
26                 </synopsis>
27   </refsynopsisdiv>
28   <!-- ===================================================================== -->
29   <!-- Parameters -->
30   <!-- ===================================================================== -->
31   <refsection>
32     <title>Parameters</title>
33     <variablelist>
34       <varlistentry>
35         <term>level</term>
36         <listitem>
37           <para>
38                                                 Character string : Filter the output matrix according to repositories
39                                                 are officials, have been added for all users or have been added for the
40                                                 current user.
41                                         </para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>repositories</term>
46         <listitem>
47           <para>
48                                                 Matrix of strings : the first column give the list of repositories
49                                                 managed by ATOMS and the second column indicate if the repository is
50                                                 a official repository, if the repository has been added for all users
51                                                 or only for the current user.
52                                         </para>
53         </listitem>
54       </varlistentry>
55     </variablelist>
56   </refsection>
57   <!-- ===================================================================== -->
58   <!-- Description -->
59   <!-- ===================================================================== -->
60   <refsection>
61     <title>Description</title>
62     <para><literal>atomsRepositoryList</literal> return a matrix that give the list of
63     available repositories.
64         </para>
65   </refsection>
66   <!-- ===================================================================== -->
67   <!-- Examples -->
68   <!-- ===================================================================== -->
69   <refsection>
70     <title>Examples</title>
71     <programlisting role="example"><![CDATA[ 
72 atomsRepositoryList()
73 atomsRepositoryList('official')
74 atomsRepositoryList('allusers')
75 atomsRepositoryList('user')
76  ]]></programlisting>
77   </refsection>
78   <!-- ===================================================================== -->
79   <!-- See also -->
80   <!-- ===================================================================== -->
81   <refsection>
82     <title>See Also</title>
83     <simplelist type="inline">
84       <member>
85         <link linkend="atomsRepositoryAdd">atomsRepositoryAdd</link>
86       </member>
87       <member>
88         <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
89       </member>
90     </simplelist>
91   </refsection>
92   <!-- ===================================================================== -->
93   <!-- Authors -->
94   <!-- ===================================================================== -->
95   <refsection>
96     <title>Authors</title>
97     <simplelist type="vert">
98       <member>Pierre MARECHAL - DIGITEO</member>
99     </simplelist>
100   </refsection>
101 </refentry>