Improve the description of getd
[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>Load 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>A string. The directory pathname</para>
29                     <para>
30                         "." if <link linkend="getd">getd</link> is called without input argument or if <literal>path</literal> is an empty string.
31                     </para>
32                 </listitem>
33             </varlistentry>
34         </variablelist>
35     </refsection>
36     <refsection>
37         <title>Description</title>
38         <para>
39             Loads all <literal>.sci</literal> files (containing Scilab functions) defined in
40             the <literal>path</literal> directory.
41         </para>
42         <para>
43             If the file does not contain a function, the script will be executed.
44         </para>
45     </refsection>
46     <refsection>
47         <title>Examples</title>
48         <programlisting role="example"><![CDATA[ 
49 getd('SCI/modules/cacsd/macros')
50  ]]></programlisting>
51     </refsection>
52     <refsection role="see also">
53         <title>See Also</title>
54         <simplelist type="inline">
55             <member>
56                 <link linkend="exec">exec</link>
57             </member>
58             <member>
59                 <link linkend="lib">lib</link>
60             </member>
61             <member>
62                 <link linkend="pwd">pwd</link>
63             </member>
64             <member>
65                 <link linkend="chdir">chdir</link>
66             </member>
67         </simplelist>
68     </refsection>
69 </refentry>