94a24ba853c995a332c63aad88bf6449f05e1c18
[scilab.git] / scilab / modules / atoms / help / en_US / atomsInstall.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="atomsInstall">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>atomsInstall</refname>
19     <refpurpose>Install one or several external modules</refpurpose>
20   </refnamediv>
21   <!-- ===================================================================== -->
22   <!-- Calling Sequence -->
23   <!-- ===================================================================== -->
24   <refsynopsisdiv>
25     <title>Calling Sequence</title>
26     <synopsis>
27           result = atomsInstall(module[,allusers]])
28         </synopsis>
29   </refsynopsisdiv>
30   <!-- ===================================================================== -->
31   <!-- Parameters -->
32   <!-- ===================================================================== -->
33   <refsection>
34     <title>Parameters</title>
35     <variablelist>
36       <varlistentry>
37         <term>module</term>
38         <listitem>
39           <para>
40                                                 Matrix of strings : External module name
41                                         </para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>allusers</term>
46         <listitem>
47           <para>
48                                                 A boolean : if this parameter is equal to TRUE (%T), the external module
49                                                 is installed for all users of the computer and is located in
50                                                 SCI/contrib ("allusers zone").
51                                                 
52                                                 If allusers is set to TRUE (%T) and the directory SCI/contrib/ is not
53                                                 write accessible, atomsInstall returns an error.
54                                                 
55                                                 if this parameter is equal to FALSE (%F), the external module is only
56                                                 installed for the current user and is located in SCIHOME/atoms ("user zone").
57                                         </para>
58         </listitem>
59       </varlistentry>
60       <varlistentry>
61         <term>result</term>
62         <listitem>
63           <para>5xn String matrix :</para>
64           <itemizedlist>
65             <listitem>
66               <para><literal>1st column</literal> : External module's technical name
67                                                         </para>
68                                                 </listitem>
69                                                 <listitem>
70                                                         <para><literal>2nd column</literal> : External module's version
71                                                         </para>
72             </listitem>
73             <listitem>
74               <para><literal>3rd column</literal> : allusers/user, this parameter tell if
75                                                                 the external module has been installed for all users or only for the
76                                                                 current user.
77                                                                 </para>
78             </listitem>
79             <listitem>
80               <para>
81                                                                 <literal>4th column</literal> : External module's installation path
82                                                         </para>
83             </listitem>
84             <listitem>
85               <para><literal>5th column</literal> : I/A, this parameter tell if
86                                                                 the external module has been automatically or intentionnaly installed.
87                                                         </para>
88             </listitem>
89           </itemizedlist>
90         </listitem>
91       </varlistentry>
92     </variablelist>
93   </refsection>
94   <!-- ===================================================================== -->
95   <!-- Description -->
96   <!-- ===================================================================== -->
97   <refsection>
98     <title>Description</title>
99     <para><literal>atomsInstall</literal> install one or more external modules.
100         </para>
101   </refsection>
102   <!-- ===================================================================== -->
103   <!-- Examples -->
104   <!-- ===================================================================== -->
105   <refsection>
106     <title>Examples</title>
107     <programlisting role="example"><![CDATA[ 
108 atomsSetConfig("Verbose","True");
109 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
110
111 atomsInstall("toolbox_5 1.0");
112 atomsInstall("toolbox_6");
113
114 atomsRemove("toolbox_5");
115 atomsRemove("toolbox_6");
116  ]]></programlisting>
117   </refsection>
118   <!-- ===================================================================== -->
119   <!-- See also -->
120   <!-- ===================================================================== -->
121   <refsection>
122     <title>See Also</title>
123     <simplelist type="inline">
124       <member>
125         <link linkend="atomsIsInstalled">atomsIsInstalled</link>
126       </member>
127       <member>
128         <link linkend="atomsGetInstalled">atomsGetInstalled</link>
129       </member>
130       <member>
131         <link linkend="atomsRemove">atomsRemove</link>
132       </member>
133     </simplelist>
134   </refsection>
135   <!-- ===================================================================== -->
136   <!-- Authors -->
137   <!-- ===================================================================== -->
138   <refsection>
139     <title>Authors</title>
140     <simplelist type="vert">
141       <member>Pierre MARECHAL - DIGITEO</member>
142     </simplelist>
143   </refsection>
144 </refentry>