8a9473930b2bc5c0d261064035878d6d6d2db60a
[scilab.git] / scilab / modules / core / help / en_US / variables / whos.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="whos">
3     <refnamediv>
4         <refname>whos</refname>
5         <refpurpose>listing of variables in long form</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>whos()
10             whos -type typ
11             whos -name nam
12         </synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>Arguments</title>
16         <variablelist>
17             <varlistentry>
18                 <term>typ</term>
19                 <listitem>
20                     <para>
21                         a name of selected variable type (see <link linkend="typeof">typeof</link>)
22                     </para>
23                 </listitem>
24             </varlistentry>
25             <varlistentry>
26                 <term>nam</term>
27                 <listitem>
28                     <para>first characters of selected names</para>
29                 </listitem>
30             </varlistentry>
31         </variablelist>
32     </refsection>
33     <refsection>
34         <title>Description</title>
35         <para>
36             <literal>whos()</literal> displays all current variable names sorted by name (case insensitive), types and memory used.
37         </para>
38         <para>
39             <literal>whos -type typ</literal> displays all current variables with specified type.
40         </para>
41         <para>
42             <literal>whos -name nam</literal> displays all current variables whose names begin with <literal>nam</literal>.
43         </para>
44         <para>Note : If a variable is global, a * appears after his type name.</para>
45     </refsection>
46     <refsection>
47         <title>Examples</title>
48         <programlisting role="example"><![CDATA[ 
49 lines(0) 
50 whos()
51 whos -type boolean
52 whos -name %
53  ]]></programlisting>
54     </refsection>
55     <refsection role="see also">
56         <title>See Also</title>
57         <simplelist type="inline">
58             <member>
59                 <link linkend="who">who</link>
60             </member>
61             <member>
62                 <link linkend="who_user">who_user</link>
63             </member>
64             <member>
65                 <link linkend="typeof">typeof</link>
66             </member>
67         </simplelist>
68     </refsection>
69 </refentry>