391241175731f4ae60072a83137e937103ab09d5
[scilab.git] / scilab / modules / functions / help / en_US / getd.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) ????-2008 - INRIA
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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getd">
14     <refnamediv>
15         <refname>getd</refname>
16         <refpurpose> getting all functions defined in a directory</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>getd(path)</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>path</term>
27                 <listitem>
28                     <para>Scilab string. The directory pathname</para>
29                 </listitem>
30             </varlistentry>
31         </variablelist>
32     </refsection>
33     <refsection>
34         <title>Description</title>
35         <para>
36             loads all <literal>.sci</literal> files (containing Scilab functions) defined in
37             the <literal>path</literal> directory.
38         </para>
39     </refsection>
40     <refsection>
41         <title>Examples</title>
42         <programlisting role="example"><![CDATA[ 
43 getd('SCI/modules/cacsd/macros')
44  ]]></programlisting>
45     </refsection>
46     <refsection role="see also">
47         <title>See Also</title>
48         <simplelist type="inline">
49             <member>
50                 <link linkend="exec">exec</link>
51             </member>
52             <member>
53                 <link linkend="lib">lib</link>
54             </member>
55             <member>
56                 <link linkend="pwd">pwd</link>
57             </member>
58             <member>
59                 <link linkend="chdir">chdir</link>
60             </member>
61         </simplelist>
62     </refsection>
63 </refentry>