d01153bc5d606a9c0bcf52d61230ab05c6fd4fbd
[scilab.git] / scilab / modules / atoms / help / en_US / atomsGetLoadedPath.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) 2011 DIGITEO - Simon GARESTE <simon.gareste@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="atomsGetLoadedPath" xml:lang="en">
14   <refnamediv>
15     <refname>atomsGetLoadedPath</refname>
16     <refpurpose>Get the list of loaded external modules</refpurpose>
17   </refnamediv>
18   <!-- ===================================================================== -->
19   <!-- Calling Sequence -->
20   <!-- ===================================================================== -->
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24       path = atomsGetLoadedPathPath(module)
25     </synopsis>
26   </refsynopsisdiv>
27   <!-- ===================================================================== -->
28   <!-- Parameters -->
29   <!-- ===================================================================== -->
30   <refsection>
31     <title>Arguments</title>
32     <variablelist>
33       <varlistentry>
34         <term>module</term>
35         <listitem>
36           <para>mx1, mx2, mx3 Matrix of strings :</para>
37           <informaltable border="1">
38             <!-- Technical name -->
39             <tr>
40               <td>
41                 <emphasis>1st Col.</emphasis>
42               </td>
43               <td>
44                 <emphasis role="strong">Technical name</emphasis>
45               </td>
46               <td>
47                 Mandatory
48               </td>
49               <td>
50               </td>
51             </tr>
52             <!-- Version -->
53             <tr>
54               <td>
55                 <emphasis>2nd Col.</emphasis>
56               </td>
57               <td>
58                 <emphasis role="strong">Version</emphasis>
59               </td>
60               <td>
61                 Optional
62               </td>
63               <td>
64                 If this field is empty or is not present,
65                 the most recent version is used
66               </td>
67             </tr>
68             <!-- Section -->
69             <tr>
70               <td>
71                 <emphasis>3nd Col.</emphasis>
72               </td>
73               <td>
74                 <emphasis role="strong">Section</emphasis>
75               </td>
76               <td>
77                 Optional
78               </td>
79               <td>
80                 If this field is empty or is not present,
81                 "allusers" is used
82               </td>
83             </tr>
84           </informaltable>
85         </listitem>
86         <term>path</term>
87         <para>The path of the given module</para>
88       </varlistentry>
89     </variablelist>
90   </refsection>
91   <!-- ===================================================================== -->
92   <!-- Description -->
93   <!-- ===================================================================== -->
94   <refsection>
95     <title>Description</title>
96     <para>
97       <literal>atomsGetLoadedPath</literal> returns the path of the module given
98     </para>
99   </refsection>
100   <!-- ===================================================================== -->
101   <!-- Examples -->
102   <!-- ===================================================================== -->
103   <refsection>
104     <title>Examples</title>
105     <programlisting role="example"><![CDATA[ 
106 atomsSetConfig("Verbose","True");
107 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
108 atomsInstall("toolbox_5");
109 atomsLoad("toolbox_5");
110
111 path = atomsGetLoadedPath("toolbox_5");
112
113 atomsRemove("toolbox_5");
114  ]]></programlisting>
115   </refsection>
116   <!-- ===================================================================== -->
117   <!-- See also -->
118   <!-- ===================================================================== -->
119   <refsection role="see also">
120     <title>See Also</title>
121     <simplelist type="inline">
122       <member>
123         <link linkend="atomsLoad">atomsLoad</link>
124       </member>
125       <member>
126         <link linkend="atomsLoad">atomsGetLoaded</link>
127       </member>
128       <member>
129         <link linkend="atomsIsLoaded">atomsIsLoaded</link>
130       </member>
131     </simplelist>
132   </refsection>
133   <!-- ===================================================================== -->
134   <!-- Authors -->
135   <!-- ===================================================================== -->
136 </refentry>