Add also the examples in core help pages in the russian help page (port of modificati...
[scilab.git] / scilab / modules / core / help / en_US / variables / who.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="who">
3     <refnamediv>
4         <refname>who</refname>
5         <refpurpose>listing of variables</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>who
10             who()
11             names = who('local')
12             [names, mem] = who('local')
13             names = who('global')
14             [names, mem] = who('global')
15             who('sorted')
16             names = who('local','sorted')
17             [names, mem] = who('local','sorted')
18             names = who('global','sorted')
19             [names, mem] = who('global','sorted')
20         </synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Description</title>
24         <para>
25             <code>who()</code> displays current variable names.
26         </para>
27         <para>
28             <code>who('local')</code> or <code>who('get')</code> returns current
29             variable names and memory used in double precision words.
30         </para>
31         <para>
32             <code>who('global')</code> returns global variable names and memory
33             used in double precision words.
34         </para>
35         <para>
36             <code>who('sorted')</code> displays in alphabetical order all variables.
37         </para>
38     </refsection>
39     <refsection>
40         <title>Examples</title>
41         <programlisting role="example"><![CDATA[
42 a=1;
43 b=2;
44 [name, mem]=who("local");
45 position=find(name=="a")
46 mem(position) // Size used by a
47 position=find(name=="d") // []
48  ]]></programlisting>
49     </refsection>
50     <refsection role="see also">
51         <title>See Also</title>
52         <simplelist type="inline">
53             <member>
54                 <link linkend="whos">whos</link>
55             </member>
56             <member>
57                 <link linkend="who_user">who_user</link>
58             </member>
59         </simplelist>
60     </refsection>
61 </refentry>