ATOMS: atomsRepositoryXXX: Better management of "allusers"/"user" sections
[scilab.git] / scilab / modules / atoms / help / en_US / atomsRepositoryDel.xml
index d5e74fa..5c343f8 100644 (file)
@@ -21,7 +21,7 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
-         nbDel = atomsRepositoryDel(url[,allusers])
+         nbDel = atomsRepositoryDel(url[,section])
        </synopsis>
   </refsynopsisdiv>
   <!-- ===================================================================== -->
         <term>url</term>
         <listitem>
           <para>
-                       Matrix of strings : list of the URLs to remove
-                 </para>
+                                               Matrix of strings : list of the URLs to remove
+                                       </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
-        <term>allusers</term>
+                       
+                       <varlistentry>
+        <term>section</term>
         <listitem>
           <para>
-                                               A boolean : if this parameter is equal to TRUE (%T), URLs are removed
-                                               from both "allusers" and "user" list.
-                                               
-                                               If allusers is set to TRUE (%T) and the directory SCI/.atoms/ is not
-                                               write accessible, atomsRepositoryDel will produce an error.
-                                               
-                                               if this parameter is equal to FALSE (%T), URLs are only removed
-                                               from "user" list.
+                                               This argument controls the list of sections where search
+                                               URL(s) to remove.
+                                       </para>
+          <para>
+                                               <literal>section</literal> is a single-string and its value should be :
+                                       </para>
+          <itemizedlist>
+            <listitem>
+              <para>
+                                                               <literal>"all"</literal>: URL(s) to remove are searched in both
+                                                               "user" and "allusers" sections.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"allusers"</literal>: URL(s) to remove are only searched in
+                                                               the "allusers" section.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"user"</literal>: URL(s) to remove are only searched in
+                                                               the "user" section.
+                                                       </para>
+            </listitem>
+          </itemizedlist>
+                                       <para>
+                                               If SCI is write accessible, "all" is the default value.
+                                               Otherwise, the default value is "user".
                                        </para>
         </listitem>
-      </varlistentry>
+                       </varlistentry>
+                       
       <varlistentry>
         <term>nbDel</term>
         <listitem>
     <title>Examples</title>
     <programlisting role="example"><![CDATA[ 
 atomsRepositoryList()
-atomsRepositoryAdd(["http://scene1.test.atoms.scilab.org")
+atomsRepositoryAdd("http://scene1.test.atoms.scilab.org")
 atomsRepositoryList()
-atomsRepositoryDel(["http://scene1.test.atoms.scilab.org")
+atomsRepositoryDel("http://scene1.test.atoms.scilab.org")
 atomsRepositoryList()
  ]]></programlisting>
   </refsection>