5547b7f34a14f76bf56610b5df75865385d8edc6
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2ps.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 xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2ps" xml:lang="en">
14     <refnamediv>
15         <refname>xs2ps</refname>
16         <refpurpose>export graphics to PS</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>
21             xs2ps(win_num, file_name [,orientation])
22             xs2ps(fig, file_name [,orientation])
23         </synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>win_num</term>
30                 <listitem>
31                     <para>an integer, ID of the figure to export.</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>fig</term>
36                 <listitem>
37                     <para>handle of the figure to export.</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>file_name</term>
42                 <listitem>
43                     <para>a string, name of the exported file.</para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>orientation</term>
48                 <listitem>
49                     <para>
50                         an optional string, with possible values 
51                         <literal>'portrait'</literal> or
52                         <literal>'landscape'</literal>. The default 
53                         value is <literal>'portrait'</literal>.
54                     </para>
55                 </listitem>
56             </varlistentry>
57         </variablelist>
58     </refsection>
59     <refsection>
60         <title>Description</title>
61         <para>
62             <function>xs2ps</function> exports the display of a graphic 
63             window into a PostScript file.
64         </para>
65         <note>
66             Note that the generated Postscript file cannot be directly 
67             printed since it requires a header file. The function 
68             <function>xs2eps</function> can be used to directly produce 
69             an encapsulated Postscript file with a header.
70         </note>
71     </refsection>
72     <refsection>
73         <title>Examples</title>
74         <programlisting role="example"><![CDATA[ 
75 scf(0);
76 plot2d();
77 // Postcript export
78 filename='foo.ps';
79 xs2ps(0,filename);
80  ]]></programlisting>
81     </refsection>
82     <refsection role="see also">
83         <title>See Also</title>
84         <simplelist type="inline">
85             <member>
86                 <literal>figure_size</literal> property
87             </member>
88             <member>
89                 <link linkend="toprint">toprint</link>
90             </member>
91             <member>
92                 <link linkend="printfigure">printfigure</link>
93             </member>
94             <member>
95                 <link linkend="xs2bmp">xs2bmp</link>
96             </member>
97             <member>
98                 <link linkend="xs2gif">xs2gif</link>
99             </member>
100             <member>
101                 <link linkend="xs2jpg">xs2jpg</link>
102             </member>
103             <member>
104                 <link linkend="xs2png">xs2png</link>
105             </member>
106             <member>
107                 <link linkend="xs2ppm">xs2ppm</link>
108             </member>
109             <member>
110                 <link linkend="xs2eps">xs2eps</link>
111             </member>
112             <member>
113                 <link linkend="xs2pdf">xs2pdf</link>
114             </member>
115             <member>
116                 <link linkend="xs2svg">xs2svg</link>
117             </member>
118             <member>
119                 <link linkend="xs2emf">xs2emf</link>
120             </member>
121         </simplelist>
122     </refsection>
123 </refentry>