0b29d4a98ed774279e20a75011c3507087d183fb
[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[,allusers])
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>allusers</term>
43         <listitem>
44           <para>
45                                                 A boolean : if this parameter is equal to TRUE (%T), URLs are added
46                                                 for all users of the computer. The list of available URL for all users
47                                                 is defined in SCI/.atoms/repositories ("allusers zone").
48                                                 
49                                                 If allusers is set to TRUE (%T) and the directory SCI/.atoms/ is not
50                                                 write accessible, atomsRepositoryAdd will produce an error.
51                                                 
52                                                 if this parameter is equal to FALSE (%T), the URL is only added
53                                                 for the current user. The list of URL only available for the current
54                                                 user is defined in SCIHOME/atoms/repositories ("user zone").
55                                         </para>
56         </listitem>
57       </varlistentry>
58       <varlistentry>
59         <term>nbAdd</term>
60         <listitem>
61           <para>
62                                                 An integer : the number of repositories successfully added.
63                                         </para>
64         </listitem>
65       </varlistentry>
66     </variablelist>
67   </refsection>
68   <!-- ===================================================================== -->
69   <!-- Description -->
70   <!-- ===================================================================== -->
71   <refsection>
72     <title>Description</title>
73     <para>
74           
75         </para>
76   </refsection>
77   <!-- ===================================================================== -->
78   <!-- Examples -->
79   <!-- ===================================================================== -->
80   <refsection>
81     <title>Examples</title>
82     <programlisting role="example"><![CDATA[ 
83 atomsRepositoryList()
84 atomsRepositoryAdd(["http://scene1.test.atoms.scilab.org"])
85 atomsRepositoryList()
86  ]]></programlisting>
87   </refsection>
88   <!-- ===================================================================== -->
89   <!-- See also -->
90   <!-- ===================================================================== -->
91   <refsection>
92     <title>See Also</title>
93     <simplelist type="inline">
94       <member>
95         <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
96       </member>
97       <member>
98         <link linkend="atomsRepositoryList">atomsRepositoryList</link>
99       </member>
100     </simplelist>
101   </refsection>
102   <!-- ===================================================================== -->
103   <!-- Authors -->
104   <!-- ===================================================================== -->
105   <refsection>
106     <title>Authors</title>
107     <simplelist type="vert">
108       <member>Pierre MARECHAL - DIGITEO</member>
109     </simplelist>
110   </refsection>
111 </refentry>