ATOMS: atomsRepositoryXXX: Better management of "allusers"/"user" sections
[scilab.git] / scilab / modules / atoms / help / en_US / atomsRepositoryAdd.xml
index 0b29d4a..4065a5d 100644 (file)
@@ -21,7 +21,7 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
-         nbAdd = atomsRepositoryAdd(url[,allusers])
+         nbAdd = atomsRepositoryAdd(url[,section])
        </synopsis>
   </refsynopsisdiv>
   <!-- ===================================================================== -->
                                        </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 added
-                                               for all users of the computer. The list of available URL for all users
-                                               is defined in SCI/.atoms/repositories ("allusers zone").
-                                               
-                                               If allusers is set to TRUE (%T) and the directory SCI/.atoms/ is not
-                                               write accessible, atomsRepositoryAdd will produce an error.
-                                               
-                                               if this parameter is equal to FALSE (%T), the URL is only added
-                                               for the current user. The list of URL only available for the current
-                                               user is defined in SCIHOME/atoms/repositories ("user zone").
+                                               This argument controls where the repository is added.
+                                       </para>
+          <para>
+                                               <literal>section</literal> is a single-string and its value should be :
+                                       </para>
+          <itemizedlist>
+            <listitem>
+              <para>
+                                                               <literal>"allusers"</literal>: the repository is added to the
+                                                               "allusers" list and all user of scilab are affected.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para><literal>"user"</literal>: the repository is added to the
+                                                               "user" list and only the current user is affected.
+                                                       </para>
+            </listitem>
+          </itemizedlist>
+                                       <para>
+                                               If SCI/contrib is write accessible, "allusers" is the default value.
+                                               Otherwise, the default value is "user".
                                        </para>
         </listitem>
-      </varlistentry>
+                       </varlistentry>
       <varlistentry>
         <term>nbAdd</term>
         <listitem>