Readd fig support in xinit/xend.sci.
[scilab.git] / scilab / modules / graphic_export / help / en_US / xinit.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
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" version="5.0-subset Scilab" xml:lang="en" xml:id="xinit">
15   <info>
16     <pubdate>$LastChangedDate$</pubdate>
17   </info>
18   <refnamediv>
19     <refname>xinit</refname>
20     <refpurpose>Initialization of a graphics driver</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>xinit(FileName)</synopsis>
25     <synopsis>xinit()</synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Parameters</title>
29     <variablelist>
30       <varlistentry>
31         <term>FileName</term>
32         <listitem>
33           <para>string: name of the export file.</para>
34         </listitem>
35       </varlistentry>
36     </variablelist>
37   </refsection>
38   <refsection>
39     <title>Description</title>
40     <para>
41     For the Postscript, Xfig, Gif or PPM driver, <literal>FileName</literal> must be specified. It is the name of 
42     the file where all the graphics operations are recorded.</para>
43     <para>For screen drivers (X11 or Rec), <literal>xinit</literal> should be called without any argument and
44           opens an empty graphic window.</para>
45   </refsection>
46   <refsection>
47     <title>Examples</title>
48     <programlisting role="example"><![CDATA[
49
50 driver("Pos")
51 xinit("foo.ps")
52 plot2d()
53 xend()
54 driver("X11")
55  
56   ]]></programlisting>
57   </refsection>
58   <refsection>
59     <title>See Also</title>
60     <simplelist type="inline">
61       <member>
62         <link linkend="driver">driver</link>
63       </member>
64       <member>
65         <link linkend="xend">xend</link>
66       </member>
67       <member>
68         <link linkend="scf">scf</link>
69       </member>
70     </simplelist>
71   </refsection>
72   <refsection>
73     <title>Authors</title>
74     <para>J.Ph.C.  </para>
75     <para>Jean-Baptiste Silvy</para>
76   </refsection>
77 </refentry>
78