d3d57f3f0836451deb694ffe40c598f7401dce57
[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  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>xinit</refname>
19     <refpurpose> initialisation of a graphics driver</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>xinit([driver-name])</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Parameters</title>
27     <variablelist>
28       <varlistentry>
29         <term>driver-name</term>
30         <listitem>
31           <para>string.</para>
32         </listitem>
33       </varlistentry>
34     </variablelist>
35   </refsection>
36   <refsection>
37     <title>Description</title>
38     <para>
39     Initialisation of the given driver.</para>
40     <para>
41     For X Window
42     <literal>driver-name</literal> can be a string which gives the name of a display
43     and a new graphics window is created. If the argument is omitted 
44     the value of the environment variable DISPLAY is used if it exists or 
45     the value "unix:0.0" is used.</para>
46     <para>
47     For the Postscript, Xfig or Gif driver, <literal>driver-name</literal> is a name of 
48     the file where all the graphics operations are recorded.</para>
49     <para>Note that in Postscript case the generated file is not a complete
50       postscript file. It should be converted using the BEpsf or Blatexpr shell
51       programs (see printing)</para>
52   </refsection>
53   <refsection>
54     <title>Examples</title>
55     <programlisting role="example"><![CDATA[
56
57 driver("Pos")
58 xinit("foo.ps")
59 plot2d()
60 xend()
61 driver("X11")
62  
63   ]]></programlisting>
64   </refsection>
65   <refsection>
66     <title>See Also</title>
67     <simplelist type="inline">
68       <member>
69         <link linkend="xbasimp">xbasimp</link>
70       </member>
71       <member>
72         <link linkend="xend">xend</link>
73       </member>
74     </simplelist>
75   </refsection>
76   <refsection>
77     <title>Authors</title>
78     <para>J.Ph.C.  </para>
79   </refsection>
80 </refentry>