Merge remote-tracking branch 'origin/6.1'
[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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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">
17     <refnamediv>
18         <refname>xs2ps</refname>
19         <refpurpose>export graphics to PS</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             xs2ps(win_num, file_name [,orientation])
25             xs2ps(fig, file_name [,orientation])
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>win_num</term>
33                 <listitem>
34                     <para>an integer, ID of the figure to export.</para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>fig</term>
39                 <listitem>
40                     <para>handle of the figure to export.</para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>file_name</term>
45                 <listitem>
46                     <para>a string, name of the exported file.</para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>orientation</term>
51                 <listitem>
52                     <para>
53                         an optional string, with possible values
54                         <literal>'portrait'</literal> or
55                         <literal>'landscape'</literal>. The default
56                         value is <literal>'portrait'</literal>.
57                     </para>
58                 </listitem>
59             </varlistentry>
60         </variablelist>
61     </refsection>
62     <refsection>
63         <title>Description</title>
64         <para>
65             <function>xs2ps</function> exports the display of a graphic
66             window into a PostScript file.
67         </para>
68         <note>
69             Note that the generated Postscript file cannot be directly
70             printed since it requires a header file. The function
71             <function>xs2eps</function> can be used to directly produce
72             an Encapsulated Postscript file with a header.
73         </note>
74     </refsection>
75     <refsection>
76         <title>Examples</title>
77         <programlisting role="example"><![CDATA[
78 scf(0);
79 plot2d();
80 // Postcript export
81 filename='foo.ps';
82 xs2ps(0,filename);
83  ]]></programlisting>
84     </refsection>
85     <refsection role="see also">
86         <title>See also</title>
87         <simplelist type="inline">
88             <member>
89                 <literal>figure_size</literal> property in <link linkend="figure_properties">figure_properties</link>
90             </member>
91             <member>
92                 <link linkend="toprint">toprint</link>
93             </member>
94             <member>
95                 <link linkend="printfigure">printfigure</link>
96             </member>
97             <member>
98                 <link linkend="xs2bmp">xs2bmp</link>
99             </member>
100             <member>
101                 <link linkend="xs2gif">xs2gif</link>
102             </member>
103             <member>
104                 <link linkend="xs2jpg">xs2jpg</link>
105             </member>
106             <member>
107                 <link linkend="xs2png">xs2png</link>
108             </member>
109             <member>
110                 <link linkend="xs2ppm">xs2ppm</link>
111             </member>
112             <member>
113                 <link linkend="xs2eps">xs2eps</link>
114             </member>
115             <member>
116                 <link linkend="xs2pdf">xs2pdf</link>
117             </member>
118             <member>
119                 <link linkend="xs2svg">xs2svg</link>
120             </member>
121             <member>
122                 <link linkend="xs2emf">xs2emf</link>
123             </member>
124         </simplelist>
125     </refsection>
126 </refentry>