ATOMS: homogenize function's profile
[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(section)
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>
48                                                                 <literal>3rd column</literal> : allusers/user, this parameter tell if
49                                                                 the external module has been installed for all users or only for the
50                                                                 current user.
51                                                         </para>
52             </listitem>
53             <listitem>
54               <para>
55                                                                 <literal>4th column</literal> : External module's installation path
56                                                         </para>
57             </listitem>
58             <listitem>
59               <para><literal>5th column</literal> : I/A, this parameter tell if
60                                                                 the external module has been automatically or intentionnaly installed.
61                                                         </para>
62             </listitem>
63           </itemizedlist>
64         </listitem>
65       </varlistentry>
66                         
67                         <varlistentry>
68         <term>section</term>
69         <listitem>
70           <para>
71                                                 This argument filter the output list.
72                                         </para>
73           <para>
74                                                 <literal>section</literal> is a single-string and its value should be :
75                                         </para>
76           <itemizedlist>
77             <listitem>
78               <para>
79                                                                 <literal>"all"</literal>: atomsGetInstalled() lists external
80                                                                 modules installed in both "user" and "allusers" sections.
81                                                         </para>
82             </listitem>
83             <listitem>
84               <para>
85                                                                 <literal>"allusers"</literal>: atomsGetInstalled() only lists
86                                                                 external modules        installed in the "allusers" section.
87                                                         </para>
88             </listitem>
89             <listitem>
90               <para>
91                                                                 <literal>"user"</literal>: atomsGetInstalled() only lists
92                                                                 external modules        installed in the "user" section.
93                                                         </para>
94             </listitem>
95           </itemizedlist>
96                                         <para>
97                                                 The default value is "all".
98                                         </para>
99         </listitem>
100                         </varlistentry>
101                         
102     </variablelist>
103   </refsection>
104   <!-- ===================================================================== -->
105   <!-- Description -->
106   <!-- ===================================================================== -->
107   <refsection>
108     <title>Description</title>
109     <para><literal>atomsGetInstalled</literal> returns the list of installed external modules
110         </para>
111   </refsection>
112   <!-- ===================================================================== -->
113   <!-- Examples -->
114   <!-- ===================================================================== -->
115   <refsection>
116     <title>Examples</title>
117     <programlisting role="example"><![CDATA[ 
118 atomsSetConfig("Verbose","True");
119 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
120 atomsInstall("toolbox_5");
121 atomsGetInstalled();
122 atomsRemove("toolbox_5");
123  ]]></programlisting>
124   </refsection>
125   <!-- ===================================================================== -->
126   <!-- See also -->
127   <!-- ===================================================================== -->
128   <refsection>
129     <title>See Also</title>
130     <simplelist type="inline">
131       <member>
132         <link linkend="atomsInstall">atomsInstall</link>
133       </member>
134       <member>
135         <link linkend="atomsIsInstalled">atomsIsInstalled</link>
136       </member>
137     </simplelist>
138   </refsection>
139   <!-- ===================================================================== -->
140   <!-- Authors -->
141   <!-- ===================================================================== -->
142   <refsection>
143     <title>Authors</title>
144     <simplelist type="vert">
145       <member>Pierre MARECHAL - DIGITEO</member>
146     </simplelist>
147   </refsection>
148 </refentry>