f641160302bdd8dc11f44dffa44fa98d9a15963c
[scilab.git] / scilab / modules / atoms / help / en_US / atomsGetInstalled.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:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="atomsGetInstalled" xml:lang="en">
14   <refnamediv>
15     <refname>atomsGetInstalled</refname>
16     <refpurpose>Get the list of installed external modules</refpurpose>
17   </refnamediv>
18   <!-- ===================================================================== -->
19   <!-- Calling Sequence -->
20   <!-- ===================================================================== -->
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24                         installed = atomsGetInstalled(allusers)
25                 </synopsis>
26   </refsynopsisdiv>
27   <!-- ===================================================================== -->
28   <!-- Parameters -->
29   <!-- ===================================================================== -->
30   <refsection>
31     <title>Parameters</title>
32     <variablelist>
33       <varlistentry>
34         <term>installed</term>
35         <listitem>
36           <para>5xn String matrix :</para>
37           <itemizedlist>
38             <listitem>
39               <para><literal>1st column</literal> : External module's technical name
40                                                         </para>
41                                                 </listitem>
42                                                 <listitem>
43                                                         <para><literal>2nd column</literal> : External module's version
44                                                         </para>
45             </listitem>
46             <listitem>
47               <para><literal>3rd column</literal> : allusers/user, this parameter tell if
48                                                                 the external module has been installed for all users or only for the
49                                                                 current user.
50                                                                 </para>
51             </listitem>
52             <listitem>
53               <para>
54                                                                 <literal>4th column</literal> : External module's installation path
55                                                         </para>
56             </listitem>
57             <listitem>
58               <para><literal>5th column</literal> : I/A, this parameter tell if
59                                                                 the external module has been automatically or intentionnaly installed.
60                                                         </para>
61             </listitem>
62           </itemizedlist>
63         </listitem>
64       </varlistentry>
65                         
66                         <varlistentry>
67         <term>allusers</term>
68         <para>If this parameter is FALSE, only the list of modules installed in the "user" zone will be returned</para>
69       </varlistentry>
70                         
71     </variablelist>
72   </refsection>
73   <!-- ===================================================================== -->
74   <!-- Description -->
75   <!-- ===================================================================== -->
76   <refsection>
77     <title>Description</title>
78     <para><literal>atomsGetInstalled</literal> returns the list of installed external modules
79         </para>
80   </refsection>
81   <!-- ===================================================================== -->
82   <!-- Examples -->
83   <!-- ===================================================================== -->
84   <refsection>
85     <title>Examples</title>
86     <programlisting role="example"><![CDATA[ 
87 atomsSetConfig("Verbose","True");
88 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
89 atomsInstall("toolbox_5");
90 atomsGetInstalled();
91 atomsRemove("toolbox_5");
92  ]]></programlisting>
93   </refsection>
94   <!-- ===================================================================== -->
95   <!-- See also -->
96   <!-- ===================================================================== -->
97   <refsection>
98     <title>See Also</title>
99     <simplelist type="inline">
100       <member>
101         <link linkend="atomsInstall">atomsInstall</link>
102       </member>
103       <member>
104         <link linkend="atomsIsInstalled">atomsIsInstalled</link>
105       </member>
106     </simplelist>
107   </refsection>
108   <!-- ===================================================================== -->
109   <!-- Authors -->
110   <!-- ===================================================================== -->
111   <refsection>
112     <title>Authors</title>
113     <simplelist type="vert">
114       <member>Pierre MARECHAL - DIGITEO</member>
115     </simplelist>
116   </refsection>
117 </refentry>