Add to possibility to input figure handles in xs2xxx routines
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2eps.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) 2008 - INRIA - Sylvestre Koumar
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 version="5.0-subset Scilab" xml:id="xs2eps" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>$LastChangedDate$</pubdate>
22   </info>
23
24   <refnamediv>
25     <refname>xs2eps</refname>
26
27     <refpurpose>send graphics to an EPS file.</refpurpose>
28   </refnamediv>
29
30   <refsynopsisdiv>
31     <title>Calling Sequence</title>
32
33     <synopsis>xs2eps(win_num, file_name [,orientation])
34 xs2eps(fig, file_name [,orientation])</synopsis>
35   </refsynopsisdiv>
36
37   <refsection>
38     <title>Parameters</title>
39
40     <variablelist>
41       <varlistentry>
42         <term>win_num</term>
43
44         <listitem>
45           <para>integer, id of the figure to export.</para>
46         </listitem>
47       </varlistentry>
48
49       <varlistentry>
50         <term>fig</term>
51
52         <listitem>
53           <para>handle of the figure to export.</para>
54         </listitem>
55       </varlistentry>
56
57       <varlistentry>
58         <term>file_name</term>
59
60         <listitem>
61           <para>string, name of the exported file.</para>
62         </listitem>
63       </varlistentry>
64
65       <varlistentry>
66         <term>orientation</term>
67
68         <listitem>
69           <para>optional character, with possible values 'portrait' or
70           'landscape'. The default value is 'portrait'.</para>
71         </listitem>
72       </varlistentry>
73     </variablelist>
74   </refsection>
75
76   <refsection>
77     <title>Description</title>
78
79     <para><literal>xs2eps</literal> exports the display of a graphic window
80     into a complete Encapsulated PostScript file.</para>
81   </refsection>
82
83   <refsection>
84     <title>Examples</title>
85
86     <programlisting role="example"> 
87     scf(0)
88     plot2d()
89     //EPS export
90     xs2eps(0,'foo.eps')
91     xs2eps(gcf(),'foo.eps')
92   </programlisting>
93   </refsection>
94
95   <refsection>
96     <title>See Also</title>
97
98     <simplelist type="inline">
99       <member><link linkend="set_posfig_dim">set_posfig_dim</link></member>
100
101       <member><link linkend="toprint">toprint</link></member>
102
103       <member><link linkend="printfigure">printfigure</link></member>
104
105       <member><link linkend="xs2bmp">xs2bmp</link></member>
106
107       <member><link linkend="xs2gif">xs2gif</link></member>
108
109       <member><link linkend="xs2jpg">xs2jpg</link></member>
110
111       <member><link linkend="xs2png">xs2png</link></member>
112
113       <member><link linkend="xs2ppm">xs2ppm</link></member>
114
115       <member><link linkend="xs2pdf">xs2pdf</link></member>
116
117       <member><link linkend="xs2svg">xs2svg</link></member>
118
119       <member><link linkend="xs2ps">xs2ps</link></member>
120
121       <member><link linkend="xs2fig">xs2fig</link></member>
122
123       <member><link linkend="xs2emf">xs2emf</link></member>
124     </simplelist>
125   </refsection>
126 </refentry>