Revision of English help pages for different functions (nothing serious).
[scilab.git] / scilab / modules / core / help / en_US / variables / clearglobal.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="clearglobal">
3     <refnamediv>
4         <refname>clearglobal</refname>
5         <refpurpose>kills global variables</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>
10             clearglobal()
11             clearglobal nam1 ... namn
12             clearglobal('nam1', ...,'namn')
13         </synopsis>
14     </refsynopsisdiv>
15     <refsection>
16         <title>Arguments</title>
17         <variablelist>
18             <varlistentry>
19                 <term>nam1,..., namn</term>
20                 <listitem>
21                     <para>valid variable names</para>
22                 </listitem>
23             </varlistentry>
24         </variablelist>
25     </refsection>
26     <refsection>
27         <title>Description</title>
28         <para>
29             <code>clearglobal()</code> kills all the global variables.
30         </para>
31         <para>
32             <literal>clearglobal nam1 ... namn</literal>  kills  the global variables given by
33             their names.
34         </para>
35         <para>
36             <note>
37                 Note that <code>clearglobal()</code> only clears 
38                 the global variables, the local copies of these global 
39                 variables are not destroyed.
40             </note>
41         </para>
42     </refsection>
43     <refsection>
44         <title>Examples</title>
45         <programlisting role="example"><![CDATA[ 
46 global a b c
47 a=1;b=2;c=3;
48 who('global')
49 clearglobal b
50 who('global')
51  ]]></programlisting>
52     </refsection>
53     <refsection role="see also">
54         <title>See Also</title>
55         <simplelist type="inline">
56             <member>
57                 <link linkend="global">global</link>
58             </member>
59             <member>
60                 <link linkend="who">who</link>
61             </member>
62         </simplelist>
63     </refsection>
64 </refentry>