Online help : converted XML files that valid the new scilab.rnc schema.
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2eps.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) 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 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="xs2eps"><info><pubdate>$LastChangedDate$</pubdate></info><refnamediv><refname>xs2eps</refname><refpurpose>save graphics to a Postscript file.</refpurpose></refnamediv>
14   
15   
16   
17   
18   
19   <refsynopsisdiv><title>Calling Sequence</title><synopsis>xs2eps(win_num,filen [,colored] [,orientation])</synopsis></refsynopsisdiv>
20   <refsection><title>Parameters</title>
21     <variablelist>
22       <varlistentry>
23         <term>win_num</term>
24         <listitem>
25           <para>integer scalar or vector .</para>
26         </listitem>
27       </varlistentry>
28       <varlistentry>
29         <term>filen</term>
30         <listitem>
31           <para>string, file name.</para>
32         </listitem>
33       </varlistentry>
34       <varlistentry>
35         <term>colored</term>
36         <listitem>
37           <para>optional integer or boolean. 0 (%f) means black and white and 1
38             (%t) means color.
39           The default value (-1) is to use a value compatible with the screen
40           status.</para>
41         </listitem>
42       </varlistentry>
43       <varlistentry>
44         <term>orientation</term>
45         <listitem>
46           <para>optional character, with possible values 'p' (portrait) or 'l' (landscape).
47           The default value  is 'p'.</para>
48         </listitem>
49       </varlistentry>
50     </variablelist>
51   </refsection>
52   <refsection><title>Description</title>
53     <para>The function xs2eps will not be available in version alpha</para>
54     <para><literal>xs2eps</literal> saves the recorded graphics of the window
55     <literal>win_num</literal> to file <literal>filen</literal> in Postscript syntax. 
56     Note that <literal>filen</literal> must not have extension.</para>
57
58     <para><literal>xs2eps</literal> produces a complete encapsulated Postscrip file. 
59     It simply  calls <literal>xs2eps</literal> and then <literal>BEpsf</literal>.</para>
60
61     <para>This function works only if the selected driver is <literal>"Rec"</literal>
62     in the window <literal>win_num</literal> or if the window is in "new style". The
63     generated postscript file does not contrains the header part</para>
64   </refsection>
65
66   <refsection><title>Examples</title><programlisting role="example"><![CDATA[ 
67     scf(0)
68     plot2d()
69     // Postscript export
70     filename='foo'; // ! no extension
71     xs2eps(0,filename)
72   ]]></programlisting></refsection>
73
74   <refsection><title>See Also</title><simplelist type="inline">
75     <member>
76       <link linkend="set_posfig_dim">set_posfig_dim</link>
77     </member>
78     <member>
79       <link linkend="printing">printing</link>
80     </member>
81             <member>
82       <link linkend="xs2bmp">xs2bmp</link>
83         </member>
84         
85         <member>
86       <link linkend="xs2gif">xs2gif</link>
87         </member>
88         
89         <member>
90       <link linkend="xs2jpg">xs2jpg</link>
91     </member>
92         
93         <member>
94       <link linkend="xs2png">xs2png</link>
95         </member>
96         
97         <member>
98       <link linkend="xs2ppm">xs2ppm</link>
99     </member>
100         
101         <member>
102       <link linkend="xs2pdf">xs2pdf</link>
103     </member>
104         
105         <member>
106       <link linkend="xs2svg">xs2svg</link>
107     </member>
108         
109         <member>
110       <link linkend="xs2ps">xs2ps</link>
111     </member>
112   
113     <member>
114       <link linkend="xs2fig">xs2fig</link>
115     </member>    
116
117     <member>
118       <link linkend="xs2emf">xs2emf</link>
119     </member>
120   </simplelist></refsection>
121 </refentry>