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