summaryrefslogtreecommitdiff
path: root/modules/functions/help/en_US/sciargs.xml
blob: 40a50424f66461bd00f9bfcd49de09f8a7008678 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
<?xml version="1.0" encoding="UTF-8"?>
<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="sciargs">
    <refnamediv>
        <refname>sciargs</refname>
        <refpurpose>scilab command line arguments</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>args = sciargs()</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Description</title>
        <para>
            This function returns a row vector of character strings containing the
            arguments of the Scilab command line. First <literal>args</literal> entry contains
            the path of the launched executable file.
        </para>
        <para>
            This function corresponds to the <literal>getarg</literal> function in C language.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
args=sciargs()
 ]]></programlisting>
    </refsection>
    
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="getenv">getenv</link>
            </member>
        </simplelist>
    </refsection>
</refentry>