summaryrefslogtreecommitdiff
path: root/modules/console/help/en_US/completion.xml
blob: bd5c100bf8ae2fbbfb07d86ff2bbc63e0aacb058 (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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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" xmlns:scilab="http://www.scilab.org" xml:id="completion" xml:lang="en">
    <refnamediv>
        <refname>completion</refname>
        <refpurpose>returns words that start with the text you pass as
            parameter.
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>r = completion(beginning_of_a_word)
            r = completion(beginning_of_a_word,dictionary)
            [functions, commands, variables, macros, graphic_properties, files] = completion(beginning_of_a_word)
            [functions, commands, variables, macros, graphic_properties] = completion(beginning_of_a_word)
            [functions, commands, variables, macros] = completion(beginning_of_a_word)
            [functions, commands, variables] = completion(beginning_of_a_word)
            [functions, commands] = completion(beginning_of_a_word)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>r</term>
                <listitem>
                    <para>a string matrix</para>
                </listitem>
            </varlistentry>
        </variablelist>
        <variablelist>
            <varlistentry>
                <term>beginning_of_a_word</term>
                <listitem>
                    <para>a string</para>
                </listitem>
            </varlistentry>
        </variablelist>
        <variablelist>
            <varlistentry>
                <term>dictionary</term>
                <listitem>
                    <para>a string ("functions", "commands", "variables", "macros",
                        "graphic_properties", "files")
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
        <variablelist>
            <varlistentry>
                <term>functions, commands, variables, macros, graphic_properties,
                    files
                </term>
                <listitem>
                    <para>a string matrix</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>Returns words that start with the text you pass as parameter.</para>
        <para>
            functions: a string matrix of functions name (C gateways). See <link linkend="what">what</link>.
        </para>
        <para>
            commands: a string matrix of command words (reserved). See <link linkend="what">what</link>.
        </para>
        <para>
            variables: a string matrix of variables names. See <link linkend="who">who</link>.
        </para>
        <para>
            macros: a string matrix of macros names. See <link linkend="who">who</link>.
        </para>
        <para>graphic_properties: a string matrix of graphic properties.</para>
        <para>files: a string matrix of files names.</para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"> 
            r = completion('w')
            r = completion('w','functions')
            r = completion('w','commands')
            r = completion('w','variables')
            r = completion('w','macros')
            r = completion('w','graphic_properties')
            r = completion('w','files')
            
            [functions,commands,variables,macros,graphic_properties,files] = completion('w')
            [functions,commands,variables,macros,graphic_properties] = completion('w')
            [functions,commands,variables,macros] = completion('w')
            [functions,commands,variables] = completion('w')
            [functions,commands] = completion('w')
        </programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="getscilabkeywords">getscilabkeywords</link>
            </member>
            <member>
                <link linkend="who">who</link>
            </member>
            <member>
                <link linkend="what">what</link>
            </member>
            <member>
                <link linkend="libraryinfo">libraryinfo</link>
            </member>
            <member>
                <link linkend="librarieslist">librarieslist</link>
            </member>
        </simplelist>
    </refsection>
</refentry>