ATOMS: atomsRepositoryXXX: Better management of "allusers"/"user" sections
[scilab.git] / scilab / modules / atoms / help / en_US / atomsRepositoryAdd.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="atomsRepositoryAdd">
14   <refnamediv>
15     <refname>atomsRepositoryAdd</refname>
16     <refpurpose>Add one or several URLs to the list of managed repositories</refpurpose>
17   </refnamediv>
18   <!-- ===================================================================== -->
19   <!-- Calling Sequence -->
20   <!-- ===================================================================== -->
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24           nbAdd = atomsRepositoryAdd(url[,section])
25         </synopsis>
26   </refsynopsisdiv>
27   <!-- ===================================================================== -->
28   <!-- Parameters -->
29   <!-- ===================================================================== -->
30   <refsection>
31     <title>Parameters</title>
32     <variablelist>
33       <varlistentry>
34         <term>url</term>
35         <listitem>
36           <para>
37                                                 Matrix of strings : list of the URLs to add
38                                         </para>
39         </listitem>
40       </varlistentry>
41                         <varlistentry>
42         <term>section</term>
43                                 
44         <listitem>
45           <para>
46                                                 This argument controls where the repository is added.
47                                         </para>
48           <para>
49                                                 <literal>section</literal> is a single-string and its value should be :
50                                         </para>
51           <itemizedlist>
52             <listitem>
53               <para>
54                                                                 <literal>"allusers"</literal>: the repository is added to the
55                                                                 "allusers" list and all user of scilab are affected.
56                                                         </para>
57             </listitem>
58             <listitem>
59               <para><literal>"user"</literal>: the repository is added to the
60                                                                 "user" list and only the current user is affected.
61                                                         </para>
62             </listitem>
63           </itemizedlist>
64                                         <para>
65                                                 If SCI/contrib is write accessible, "allusers" is the default value.
66                                                 Otherwise, the default value is "user".
67                                         </para>
68         </listitem>
69                         </varlistentry>
70       <varlistentry>
71         <term>nbAdd</term>
72         <listitem>
73           <para>
74                                                 An integer : the number of repositories successfully added.
75                                         </para>
76         </listitem>
77       </varlistentry>
78     </variablelist>
79   </refsection>
80   <!-- ===================================================================== -->
81   <!-- Description -->
82   <!-- ===================================================================== -->
83   <refsection>
84     <title>Description</title>
85     <para>
86           
87         </para>
88   </refsection>
89   <!-- ===================================================================== -->
90   <!-- Examples -->
91   <!-- ===================================================================== -->
92   <refsection>
93     <title>Examples</title>
94     <programlisting role="example"><![CDATA[ 
95 atomsRepositoryList()
96 atomsRepositoryAdd(["http://scene1.test.atoms.scilab.org"])
97 atomsRepositoryList()
98  ]]></programlisting>
99   </refsection>
100   <!-- ===================================================================== -->
101   <!-- See also -->
102   <!-- ===================================================================== -->
103   <refsection>
104     <title>See Also</title>
105     <simplelist type="inline">
106       <member>
107         <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
108       </member>
109       <member>
110         <link linkend="atomsRepositoryList">atomsRepositoryList</link>
111       </member>
112     </simplelist>
113   </refsection>
114   <!-- ===================================================================== -->
115   <!-- Authors -->
116   <!-- ===================================================================== -->
117   <refsection>
118     <title>Authors</title>
119     <simplelist type="vert">
120       <member>Pierre MARECHAL - DIGITEO</member>
121     </simplelist>
122   </refsection>
123 </refentry>