Changed the description of the purpose of function xinit.
[scilab.git] / scilab / modules / graphic_export / help / en_US / xinit.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
5  * Copyright (C) 2008 - INRIA - Jean-Baptiste Silvy
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14 <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="xinit">
15     <refnamediv>
16         <refname>xinit</refname>
17         <refpurpose>open a graphics export session</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Calling Sequence</title>
21         <synopsis>
22             xinit(FileName)
23             xinit()
24         </synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>Arguments</title>
28         <variablelist>
29             <varlistentry>
30                 <term>FileName</term>
31                 <listitem>
32                     <para>a string: name of the export file.</para>
33                 </listitem>
34             </varlistentry>
35         </variablelist>
36     </refsection>
37     <refsection>
38         <title>Description</title>
39         <para>
40             <function>xinit</function> opens a graphics export session.
41             To export to a file, <varname>FileName</varname> must be 
42             specified. It is the name of the file where all the graphics 
43             operations are recorded.
44         </para>
45         <para>
46             For screen drivers (<literal>X11</literal> or <literal>Rec</literal>),
47             <function>xinit</function> should be called without any argument
48             and it will open an empty graphic window.
49         </para>
50     </refsection>
51     <refsection>
52         <title>Examples</title>
53         <programlisting role="example"><![CDATA[ 
54 current_driver = driver()
55 driver("Pos")
56 xinit(TMPDIR+"/foo.ps")
57 plot2d()
58 xend()
59 driver(current_driver)
60  ]]></programlisting>
61         <programlisting role="example"><![CDATA[ 
62 current_driver = driver()
63 driver("PNG")
64 xinit(TMPDIR+"/foo.png")
65 plot3d()
66 xend()
67 driver(current_driver)
68  ]]></programlisting>
69     </refsection>
70     <refsection role="see also">
71         <title>See Also</title>
72         <simplelist type="inline">
73             <member>
74                 <link linkend="driver">driver</link>
75             </member>
76             <member>
77                 <link linkend="xend">xend</link>
78             </member>
79             <member>
80                 <link linkend="scf">scf</link>
81             </member>
82         </simplelist>
83     </refsection>
84 </refentry>