Revision of English help pages for different functions (nothing serious).
[scilab.git] / scilab / modules / core / help / en_US / variables / who_user.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_user">
3     <refnamediv>
4         <refname>who_user</refname>
5         <refpurpose>listing of user's variables</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>varList = who_user([bPrint])</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>bPrint</term>
16                 <listitem>
17                     <para>
18                         enable or disable screen outputs (default: <constant>%t</constant>).
19                     </para>
20                 </listitem>
21             </varlistentry>
22         </variablelist>
23     </refsection>
24     <refsection>
25         <title>Return value</title>
26         <variablelist>
27             <varlistentry>
28                 <term>varList</term>
29                 <listitem>
30                     <para>
31                         a column vector of user's variables or <listing>[]</listing> if user does not have variable.
32                     </para>
33                 </listitem>
34             </varlistentry>
35         </variablelist>
36     </refsection>
37     <refsection>
38         <title>Description</title>
39         <para>
40             <literal>who_user</literal> displays and/or returns user's variable names.
41         </para>
42     </refsection>
43     <refsection>
44         <title>Examples</title>
45         <programlisting role="code_scilab"><![CDATA[ 
46 clear;
47 who_user()
48 who_user(%t)
49 who_user(%f)
50 a = 1;
51 b = 2;
52 who_user()
53 who_user(%t)
54 who_user(%f)
55 clear;
56  ]]>
57         </programlisting>
58     </refsection>
59     <refsection role="see also">
60         <title>See Also</title>
61         <simplelist type="inline">
62             <member>
63                 <link linkend="whos">whos</link>
64             </member>
65             <member>
66                 <link linkend="who">who</link>
67             </member>
68         </simplelist>
69     </refsection>
70     <refsection>
71         <title>History</title>
72         <revhistory>
73             <revision>
74                 <revnumber>5.4.0</revnumber>
75                 <revremark>
76                     <function>who_user</function> can now return user's 
77                     variable names in a column vector of character strings.
78                 </revremark>
79             </revision>
80         </revhistory>
81     </refsection>
82 </refentry>